/*
 * Copyright [2021-present] [ahoo wang <ahoowang@qq.com> (https://github.com/Ahoo-Wang)].
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *      http://www.apache.org/licenses/LICENSE-2.0
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package me.ahoo.wow.api.naming

/**
 * Interface for entities that provide a summary or brief description.
 *
 * This interface allows objects to include concise summary information that
 * provides a quick overview or abstract of the entity's content or purpose.
 */
interface SummaryCapable {
    /**
     * A brief summary of the entity.
     *
     * @return A string containing a concise summary or overview.
     */
    val summary: String
}
